home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / qqhelp.arc / QQHELP.DOC < prev    next >
Encoding:
Text File  |  1991-03-01  |  19.0 KB  |  499 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                                                 Page 1 of 10
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                       QQQQ    H    H  EEEEEE  L       PPPPP
  13.                      Q    Q   H    H  E       L       P    P
  14.                      Q    Q   H    H  E       L       P    P
  15.                      Q    Q   HHHHHH  EEEE    L       PPPPP
  16.                      Q  Q Q   H    H  E       L       P
  17.                      Q    Q   H    H  E       L       P
  18.                       QQQQ Q  H    H  EEEEEE  LLLLLL  P
  19.                             Q
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                                    QHelp
  26.  
  27.                                version 1.10
  28.                                February 1991
  29.  
  30.  
  31.                 Quick Help shell for QEdit and other programs.
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.                          Written by Dale A. Keller
  41.                    Copyright February 1991, Dale A. Keller
  42.                                   Freeware
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.                                                                 Page 2 of 10
  51.  
  52.  
  53.  
  54.         -------------------------------------------------------------
  55.                                 QHelp
  56.         -------------------------------------------------------------
  57.  
  58.  
  59.  
  60.  
  61.                           Table of Contents
  62.  
  63.  
  64.                 Section                        Page
  65.                 ------------------------       ----
  66.  
  67.                 List of Features                3
  68.  
  69.                 Introduction                    4
  70.  
  71.                 Installation/Configuration      5
  72.  
  73.                 Using QHelp                     8
  74.  
  75.                 Version History                10
  76.  
  77.                 About the Author               10
  78.  
  79.  
  80.  
  81.  
  82.  
  83.                                                                 Page 3 of 10
  84.  
  85.         ---------------------------------------------------------
  86.                             List of Features
  87.         ---------------------------------------------------------
  88.  
  89.         o Pop-up help screen for QEdit and other programs.
  90.  
  91.         o Easy to use - menu driven.
  92.  
  93.         o The help text file can be up to 799 lines long.
  94.  
  95.         o You can have a different help text file for each sub-
  96.           directory you use.  QHelp will automatically select the
  97.           help text file from your current subdirectory - so you
  98.           can have a different help text file for each program
  99.           you use.  For instance: you can have a help file tailored
  100.           to Assembly Language in your assembler directory, and one
  101.           tailored to the C Language in your C directory.
  102.  
  103.         o Speed Search facility allows you to type the word you are
  104.           looking for, and QHelp will immediatly find and highlight
  105.           it in the help text.
  106.  
  107.         o Uses Expanded Memory if available to store the help text
  108.           file - QHelp then uses only about 13K of conventional
  109.           memory.  Removes itself from memory after use so no memory
  110.           is taken from other programs.
  111.  
  112.         o Pop-up ASCII chart.
  113.  
  114.         o Pop-up Color Attribute chart displayed in Hex and Decimal.
  115.  
  116.         o Pop-up Printer Setup codes selected from a menu, or you
  117.           can 'roll your own'.
  118.  
  119.         o Fully configurable - change colors, hot-key, help text,
  120.           and printer setup codes.
  121.  
  122.         o Desqview compatible.
  123.  
  124.         o Can be used in dense screen formats (like 132 x 60).
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.                                                                 Page 4 of 10
  132.  
  133.  
  134.         ---------------------------------------------------------
  135.                                 Introduction
  136.         ---------------------------------------------------------
  137.  
  138.         Qhelp is a shell program which pops up a help file, an
  139.         ASCII chart, a Screen Attribute chart, and sends setup
  140.         codes to a printer.  When you run QHelp, it loads into
  141.         memory and then loads QEdit or another program. QHelp
  142.         does nothing until you hit the hot key.  It then pops up
  143.         a menu allowing you to select Help text, the ASCII chart,
  144.         the Color codes chart, or the Printer Setups.  When you
  145.         exit QEdit (or other program), QHelp also unloads itself
  146.         from memory.  This keeps memory clear - not taking up
  147.         memory as a TSR (Terminate and Stay Resident) program
  148.         would.
  149.  
  150.         QHelp was designed for use with QEdit, and therefore
  151.         looks and feels a lot like QEdit.  Like Qedit, it is
  152.         very configurable - you can alter screen colors, the
  153.         hot key, the help text, the printer setup codes, and even
  154.         the program it calls.  In other words, you can install
  155.         QHelp to call ANY program - not just QEdit.
  156.  
  157.         QHelp is primarily for programmers, as is QEdit.  There-
  158.         fore, it is aimed at programmers needs (ASCII and color
  159.         charts).  But if you need to add a help screen to any
  160.         other program, it should do the job.
  161.  
  162.  
  163.  
  164.  
  165.                                                                 Page 5 of 10
  166.  
  167.  
  168.         --------------------------------------------------------
  169.                     Installation/Configuration
  170.         --------------------------------------------------------
  171.  
  172.         QHelp requires an IBM PC, AT, or compatible running PC-
  173.         DOS or MS-DOS, and takes up about 13K bytes.  Your com-
  174.         puter must also have enough memory to load the program
  175.         to which you are adding the pop-up help.  Qhelp will use
  176.         expanded memory (version 3.2 or above) if available.
  177.  
  178.  
  179.         The QHelp package should contain the following files:
  180.  
  181.           QQ.EXE          the QHelp program
  182.           QQCONFIG.EXE    the QHelp configuration program
  183.           QQHELP.TXT      the QEdit help text file
  184.           QQHELP.TC       the QEdit/TurboC help text file
  185.           QQHELP.AS       the QEdit/Turbo Assembler help text file
  186.           QQHELP.DOC      this manual
  187.  
  188.           Note that all files start with QQ to differentiate
  189.           between QHelp, QEdit, and other files.
  190.  
  191.         To install QHelp, just copy these files to your working
  192.         disk where you keep QEdit (or whatever program you will be
  193.         adding QHelp to).  The only files required to actually run
  194.         QHelp are QQ.EXE and QQHELP.TXT.
  195.  
  196.         The QHelp program itself contains the ASCII and Color charts,
  197.         and the Printer Setup codes.  The help text file is loaded
  198.         at run time.  The QQCONFIG.EXE program is used to modify
  199.         the screen colors, the hot key, the printer setup strings,
  200.         and the name of the help text file and the program to
  201.         execute (usually QEdit).  More on this in a moment.
  202.  
  203.                     --- Modifying the Help Text ---
  204.  
  205.         If you want to modify QQHELP.TXT, just edit it with an
  206.         ASCII text processor. The file may contain up to 799
  207.         lines of 80 characters plus a CR/LF.  This is easiest to
  208.         do if you build your text file and then use the QEdit line
  209.         drawing function to draw a box around the entire text.
  210.         This will make each line the same length (they MUST be 80
  211.         characters wide).  Check the number of lines when you
  212.         finish.
  213.  
  214.         The files QQHELP.TC and QQHELP.ASM are help files which
  215.         have been tailored for Turbo C and Turbo Assembler. To
  216.         use these files, place them in the subdirectories where
  217.         you will use them and rename them to QQHELP.TXT.  You
  218.         can also place the standard QQHELP.TXT file in a sub-
  219.         directory which is listed in your PATH, so when you load
  220.         QHelp from a directory which does not have it's own help
  221.         text file, the standard help text file will be loaded.
  222.  
  223.  
  224.  
  225.                                                                 Page 6 of 10
  226.  
  227.                    --- Modifying the way QHelp Runs ---
  228.  
  229.         To modify the way QHelp operates, run QQCONFIG. It will ask
  230.         for the program name to configure.  This will normally be
  231.         QQ.EXE unless you rename QQ.EXE to something else.  Just
  232.         press Enter if you want to accept the default.  QQCONFIG
  233.         will read in the default parameters from QQ.EXE and check
  234.         the version number.
  235.  
  236.         QQCONFIG then asks for the name of the program to execute
  237.         from the shell.  If you accept the default Q.EXE, QHelp will
  238.         run QEdit.  If you want to install QHelp for a different
  239.         program, enter its name here.  When QHelp is run, it will
  240.         install its hot key help, and then execute whatever program
  241.         you specify here.
  242.  
  243.           Technical note: QHelp chains itself into the interrupt 16h
  244.           keyboard handler of the BIOS to trap the hot key.  If you
  245.           install QHelp to run a program which does not use the
  246.           standard BIOS to get its keyboard input, QHelp won't pop
  247.           up.  Sorry - I had to do this to make it DesqView compat-
  248.           ible.
  249.  
  250.         QQCONFIG then asks for the name of the help file.  This is
  251.         the text help file you should have created earlier.  The
  252.         default is QQHELP.TXT.
  253.  
  254.         A menu then allows you to select the options to set.
  255.  
  256.                     --- Modifying QHelp's Colors ---
  257.  
  258.         To change the colors of the QHelp screen elements, select
  259.         1 - Modify Colors.  A color attribute chart will then be
  260.         displayed, and you will be asked to select colors for each
  261.         of QHelp's elements.  The color shown in brackets is the
  262.         default, and will be used if you just press Enter.
  263.  
  264.         QHelp comes configured for a monochrome screen, to be
  265.         compatible with as many systems as possible.
  266.  
  267.                      --- Changing the Hot Key ---
  268.  
  269.         To modify the hot key which triggers QHelp, select 3 -
  270.         Modify Hot Key.  The hot key to trigger QHelp may be
  271.         changed by pressing the hot key combination you desire at
  272.         the prompt.  For example, pressing the  'Ctrl F1'  keys
  273.         will change the hot key installed in QHelp to Ctrl F1.  Just
  274.         pressing Enter will install the default hot key.  I normally
  275.         use   'Alt h'  to make QHelp pop up where the QEdit help
  276.         screen would be if QHelp wasn't running.
  277.  
  278.         Note: The only hot keys allowed are the F1 thru F10 keys,
  279.               or any letter key, in combination with nothing, the
  280.               Alt key, Ctrl key, or Shift key.
  281.  
  282.  
  283.  
  284.                                                                 Page 7 of 10
  285.  
  286.                   --- Changing the Printer Setups ---
  287.  
  288.         To modify the printer setup codes, select 2 - Modify
  289.         Printer Setups.  You may change the name of the printer.
  290.         This is the name which will appear at the top of the printer
  291.         setups menu - it does not effect the operation of the
  292.         program.  The name may be up to 20 characters long.
  293.  
  294.         For each of the 10 setup strings, the current menu selection
  295.         text will be displayed, and then the actual printer setup
  296.         code.  You may modify the menu entry text, which will
  297.         appear in the menu when running QHelp.  Each item may be up
  298.         to 20 characters long.  You may then modify the printer setup
  299.         codes.  See the section on Using QHelp - Using the Printer
  300.         Setups for the format of these codes.  Each code may be up to
  301.         20 bytes long.
  302.  
  303.         If you want to use less than the maximum of 10 setup strings,
  304.         put 'X' in the Menu Entry after the last valid entry.  This
  305.         entry and all entries after this will then show 'Roll-Your-
  306.         Own' in the menu entry.  Do not put any menu entries or setup
  307.         codes after the 'X' or the pop-up menu will show nonsense
  308.         entries.
  309.  
  310.         QHelp comes configured for an Epson LQ-1000, which uses most
  311.         of the same codes as other Epson printers, the IBM Proprinter,
  312.         and many other printers.  Check the setup codes with QQCONFIG
  313.         and you may be able to use the existing codes with your
  314.         printer, just changing the printer name.
  315.  
  316.  
  317.                       --- Saving Your Changes ---
  318.  
  319.         If you select S - Save and Exit, QQCONFIG will modify the
  320.         QQ.EXE program to reflect your configuration.  If you select
  321.         A - Abort and Exit, QQCONFIG will exit without modifying
  322.         QQ.EXE.
  323.  
  324.  
  325.  
  326.                                                                 Page 8 of 10
  327.  
  328.         ---------------------------------------------------------
  329.                             Using QHelp
  330.         ---------------------------------------------------------
  331.  
  332.         To use QHelp, type QQ (or whatever name you changed it to
  333.         during configuration). You can follow the program name
  334.         with parameters needed by QEdit (or your program). For
  335.         instance, to use QHelp with QEdit to edit a file named
  336.         test.c
  337.  
  338.                 QQ test.c
  339.  
  340.         QHelp will start, install the help hotkey, and then run
  341.         QEdit, passing the parameter 'test.c' to it.
  342.  
  343.         In other words, you run QHelp just like you run QEdit,
  344.         except you type   QQ filename   instead of   Q filename.
  345.  
  346.         QHelp will look for QEdit (Q.EXE) first in the current
  347.         directory, and then through all directories listed in the
  348.         PATH variable (just as DOS does).  Then it will look for
  349.         the help text file (QQHELP.TXT) first in the current dir-
  350.         ectory, and then along the path.
  351.  
  352.                        --- Popping QHelp Up ---
  353.  
  354.         While running QEdit, press the hot key you defined in the
  355.         configuration program.  The help menu will pop up giving
  356.         you a choice of Help, ASCII, Colors, or Printer Setups.
  357.         You may press the first letter of the item (H, A, C, or P)
  358.         or you may use the up and down arrows to move to the item
  359.         and then press Enter.  Pressing Esc will return you to
  360.         QEdit.
  361.  
  362.                   --- Using the Help Text Screen ---
  363.  
  364.         On the Help Text screen, you can scroll up or down by
  365.         pressing the up/down arrows or the PgUp/PgDn keys. To
  366.         return to QEdit, press Esc.
  367.  
  368.         To search for a keyword on the Help Text screen, simply
  369.         start typing the word.  QHelp will search through the
  370.         text until it finds a string of characters which matches
  371.         what you have typed, and will highlight this string.
  372.         As you continue to type, QHelp will search for matching
  373.         text.  If you want to find the next occurance of the
  374.         string, press Enter.  Example:
  375.  
  376.             To find the string 'box',
  377.                 type b          QHelp highlights the first 'b'
  378.                                 it finds in the help text.
  379.                 type o          QHelp highlights the first 'bo'
  380.                                 it finds in the help text.
  381.                 type x          QHelp highlights the first 'box'
  382.                                 it finds in the help text.
  383.                 press Enter     QHelp highlights the 2nd 'box'
  384.                                 it finds in the help text.
  385.  
  386.  
  387.  
  388.  
  389.  
  390.                                                                 Page 9 of 10
  391.  
  392.                     --- Using the ASCII Chart ---
  393.  
  394.         On the ASCII chart, the PgUp/PgDn and the Up/Down arrow
  395.         keys will move you through the complete chart.  The Esc
  396.         key will return you to QEdit.
  397.  
  398.                     --- Using the Color Chart ---
  399.  
  400.         On the Color chart, the Esc key will return you to QEdit.
  401.  
  402.                   --- Using the Printer Setups ---
  403.  
  404.         On the Printer Setups menu, you can select any of the
  405.         predifined setup strings, and QHelp will send the string
  406.         to the printer.  If you want to send a setup string
  407.         which is not predifined, select Roll-Your-Own.  You can
  408.         then type the control codes into the text window.  Control
  409.         codes must be characters from the keyboard, or must use the
  410.         Lotus 123 format (a backslash followed by a three digit
  411.         decimal number representing the code).
  412.  
  413.           Example:
  414.  
  415.           To send the Epson reset command (Esc @), type
  416.  
  417.                 \027@
  418.  
  419.           or for the Compressed Elite command (15 Esc M), type
  420.  
  421.                 \015\027M
  422.  
  423.  
  424.  
  425.                   --- Exiting From QHelp & QEdit ---
  426.  
  427.         When you exit from QEdit, control returns to QHelp, which
  428.         exits back to DOS, returning all memory to the system.
  429.  
  430.         QHelp takes up about 13K bytes of memory if it uses
  431.         Expanded Memory to store the help text file. If Expanded
  432.         Memory is not available, it requires about 13K bytes plus
  433.         whatever is needed to store the help text.  You can run
  434.         QEdit alone just as you did before if you need the extra
  435.         memory.
  436.                                                               
  437.  
  438.  
  439.  
  440.                                                                 Page 10 of 10
  441.  
  442.  
  443.         ---------------------------------------------------------
  444.                              Version History
  445.         -----------------------------------------------------------
  446.         Version 1.00 released January 1990.
  447.  
  448.           Included a 75 line help text file, a color chart, and an
  449.           ASCII chart.
  450.  
  451.         -----------------------------------------------------------
  452.         Version 1.10 released February 1991.
  453.  
  454.           Modifications in version 1.10 include:
  455.  
  456.         - Now uses Expanded Memory (v3.2 or above) if available.
  457.         - Fixed 'PATH' problem some users experienced, where QHelp
  458.           could not locate the Q.EXE file.
  459.         - Added a Printer Setup menu.
  460.         - Added DesqView compatibility.
  461.         - Help text files can now be up to 799 lines long.
  462.         - Added speed search to locate words on the help screen.
  463.         - Added a decimal color chart (now has both Hex and Decimal).
  464.         - Now uses the help text file found in the current sub-
  465.           directory, or along the path.  (Allows the use of
  466.           a different help text file in each subdirectory).
  467.           Note: You no longer have to run QQCONFIG if you change
  468.           your QQHELP.TXT file, because the help text is no longer
  469.           stored in the QQ.EXE file.
  470.         - Cleaned up the style of the screens so they look more
  471.           consistant.
  472.  
  473.  
  474.  
  475.  
  476.         ---------------------------------------------------------
  477.                              About the Author
  478.         ---------------------------------------------------------
  479.  
  480.         QHelp was written in Turbo Assembler by Dale A. Keller.
  481.         Dale lives in Denver, CO. with his wife and two sons, and
  482.         has been a COBOL (yuck), BASIC, C, and assembly programmer
  483.         since the days of 6502 based single board computers (back
  484.         when High Res meant 24 x 16 text in 2 colors - black and
  485.         white).
  486.  
  487.         Questions or enhancement suggestions should be sent to:
  488.  
  489.                 Dale A. Keller
  490.                 3255 S. Estes St.
  491.                 Lakewood, CO. 80227
  492.  
  493.         This version (1.10) of QHelp is distributed as Freeware.
  494.         Copyright February 1991, Dale A. Keller.
  495.         No fee may be charged for its use.
  496.  
  497.         ---------------------------------------------------------
  498.  
  499.